Set edx.org theme as default for edx-platform and MFEs by mfarhan943 · Pull Request #67 · edx/devstack

mfarhan943 · 2024-11-06T07:26:53Z

Description:
Automate setting the edx.org theme as the default for both the edx-platform and MFEs during devstack provisioning.

Related Ticket:
edx/edx-arch-experiments#824

options.mk

…ack provisioning

dianakhuang · 2024-12-16T16:53:55Z

@mfarhan943 are we waiting for a rereview from @adamstankiewicz or something else on this PR?

mfarhan943 · 2024-12-16T17:07:37Z

@dianakhuang Yes, we are waiting for @adamstankiewicz review.

adamstankiewicz · 2024-11-14T16:55:52Z

docker-compose.yml

    working_dir: '/edx/app/frontend-app-program-console'
    container_name: "edx.${COMPOSE_PROJECT_NAME:-devstack}.frontend-app-program-console"
+    environment:
+      PARAGON_BRAND_PACKAGE: '@edx/brand-edx.org'


nit: @edx/brand-edx.org@2

The update file contains the value @edx/brand-edx.org@1.x, which I updated from this source.

adamstankiewicz · 2024-11-20T14:05:53Z

docker-compose.yml

    working_dir: '/edx/app/frontend-app-account'
    container_name: "edx.${COMPOSE_PROJECT_NAME:-devstack}.frontend-app-account"
+    environment:
+      PARAGON_BRAND_PACKAGE: '@edx/brand-edx.org@@1.x'


Suggested change

PARAGON_BRAND_PACKAGE: '@edx/brand-edx.org@@1.x'

PARAGON_BRAND_PACKAGE: '@edx/brand-edx.org@1.x'

adamstankiewicz · 2024-11-20T14:06:45Z

docker-compose.yml

    working_dir: '/edx/app/frontend-app-profile'
    container_name: "edx.${COMPOSE_PROJECT_NAME:-devstack}.frontend-app-profile"
+    environment:
+      PARAGON_BRAND_PACKAGE: '@edx/brand-edx.org'


As is, this will pull from latest, which could introducing breaking changes unintentionally if a new major version is released.

Suggested change

PARAGON_BRAND_PACKAGE: '@edx/brand-edx.org'

PARAGON_BRAND_PACKAGE: '@edx/brand-edx.org@~2.0.0'

https://github.com/edx/edx-internal/blob/b3bd6adf8407b986349272f33b37922c620d8857/frontends/frontend-app-profile/prod_config.yml#L26

adamstankiewicz · 2024-11-20T14:07:16Z

docker-compose.yml

    working_dir: '/edx/app/frontend-app-authn'
    container_name: "edx.${COMPOSE_PROJECT_NAME:-devstack}.frontend-app-authn"
+    environment:
+      PARAGON_BRAND_PACKAGE: '@edx/brand-edx.org@~2.0.0'


edx-internal shows this version as 2.x currently.

Suggested change

PARAGON_BRAND_PACKAGE: '@edx/brand-edx.org@~2.0.0'

PARAGON_BRAND_PACKAGE: '@edx/brand-edx.org@2.x'

https://github.com/edx/edx-internal/blob/b3bd6adf8407b986349272f33b37922c620d8857/frontends/frontend-app-authn/prod_config.yml#L58

adamstankiewicz · 2024-11-20T14:14:49Z

docker-compose.yml

    working_dir: '/edx/app/frontend-app-course-authoring'
    container_name: "edx.${COMPOSE_PROJECT_NAME:-devstack}.frontend-app-course-authoring"
+    environment:
+      PARAGON_BRAND_PACKAGE: '@edx/brand-edx.org'


It appears this MFE does not install @edx/brand-edx.org in the standard way, instead manually installing it in the gocd pipeline itself (source).

That said, it currently installs 2.x, not latest.

adamstankiewicz · 2024-11-20T14:22:16Z

docker-compose.yml

    working_dir: '/edx/app/frontend-app-gradebook'
    container_name: "edx.${COMPOSE_PROJECT_NAME:-devstack}.frontend-app-gradebook"
+    environment:
+      PARAGON_BRAND_PACKAGE: '@edx/brand-edx.org'


Note: it doesn't appear frontend-app-gradebook uses @edx/brand-edx.org today. See production app in screenshot below; the button styles are from the default Paragon styles, not @edx/brand-edx.org.

Would we want to update the devstack MFE to use @edx/brand-edx.org when stage/prod does not? For this PR, I might recommend not adding @edx/brand-edx.org for MFEs that seemingly don't use it. You might consider coordinating with the owning teams to start using the @edx/brand-edx.org theme in stage/prod/devstack.

adamstankiewicz · 2024-11-20T14:22:46Z

docker-compose.yml

+    working_dir: '/edx/app/frontend-app-ora-grading@2.x'
    container_name: "edx.${COMPOSE_PROJECT_NAME:-devstack}.frontend-app-ora-grading"
+    environment:
+      PARAGON_BRAND_PACKAGE: '@edx/brand-edx.org'


The version 2.x was incorrectly added to the working_dir; it should be on the PARAGON_BRAND_PACKAGE.

Related, edx-internal doesn't define an NPM_ALIAS for this MFE (source). However, it is running the @edx/brand-edx.org theme, as it's installed by default in the upstream MFE package.json (source), which is incorrect as @edx/brand-edx.org is 2U/edX.org specific and should not be in openedx repo.

Might be worth coordinating with the owning team to get @edx/brand-edx.org used within NPM_ALIAS in edx-internal instead, and keeping @edx/brand-openedx installed by default in the MFE, which is convention.

adamstankiewicz · 2024-11-20T14:32:49Z

docker-compose.yml

    working_dir: '/edx/app/frontend-app-library-authoring'
    container_name: "edx.${COMPOSE_PROJECT_NAME:-devstack}.frontend-app-library-authoring"
+    environment:
+      PARAGON_BRAND_PACKAGE: '@edx/brand-edx.org'


Here's another instance where @edx/brand-edx.org is actually installed via the GoCD pipeline file vs. the typical NPM_ALIASES config (source). That said, the version appears to be 2.x.

adamstankiewicz · 2024-12-18T12:58:54Z

microfrontend.yml

+          if [ -n "$(printenv PARAGON_BRAND_PACKAGE)" ]; then
+              npx paragon install-theme "$(printenv PARAGON_BRAND_PACKAGE)" || exit 1


Looks great; seems to work well locally.

mfarhan943 · 2024-12-19T11:10:25Z

@adamstankiewicz I have updated the PR with your suggested changes. Regarding frontend-app-gradebook and frontend-app-ora-grading, I have informed arbi-bom.
CC: @iamsobanjaved

mfarhan943 self-assigned this Nov 6, 2024

mfarhan943 requested a review from adamstankiewicz November 7, 2024 07:59

adamstankiewicz reviewed Nov 13, 2024

View reviewed changes

options.mk Outdated Show resolved Hide resolved

options.mk Outdated Show resolved Hide resolved

mfarhan943 added 2 commits November 14, 2024 20:54

feat: set edx.org theme as default for edx-platform and MFEs in devst…

b1cc743

…ack provisioning

feat: Enable per-MFE PARAGON_BRAND_PACKAGE for theme versioning

b2d1484

mfarhan943 force-pushed the farhan/default-edx-theme branch from 361136b to b2d1484 Compare November 14, 2024 15:54

chore: update edx/brand versions for MFEs

d0948d4

dianakhuang mentioned this pull request Dec 16, 2024

Support updating theme repos edx/edx-arch-experiments#853

Closed

adamstankiewicz reviewed Dec 18, 2024

View reviewed changes

chore: update edx/brand versions for multiple MFEs

e2e7a62

UsamaSadiq assigned UsamaSadiq and unassigned mfarhan943 Jan 13, 2025

UsamaSadiq requested a review from adamstankiewicz January 13, 2025 12:13

adamstankiewicz approved these changes Jan 21, 2025

View reviewed changes

huniafatima-99 merged commit cdfa616 into master Jan 29, 2025
11 checks passed

huniafatima-99 deleted the farhan/default-edx-theme branch January 29, 2025 09:55

	PARAGON_BRAND_PACKAGE: '@edx/brand-edx.org@@1.x'
	PARAGON_BRAND_PACKAGE: '@edx/brand-edx.org@1.x'

		if [ -n "$(printenv PARAGON_BRAND_PACKAGE)" ]; then
		npx paragon install-theme "$(printenv PARAGON_BRAND_PACKAGE)" \|\| exit 1

Conversation

mfarhan943 commented Nov 6, 2024

Uh oh!

Uh oh!

Uh oh!

dianakhuang commented Dec 16, 2024

Uh oh!

mfarhan943 commented Dec 16, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mfarhan943 commented Dec 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

mfarhan943 commented Dec 19, 2024 •

edited

Loading